Skip to content

Group typo fixes n°5 #5959

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Draft
wants to merge 3 commits into
base: master
Choose a base branch
from
Draft

Group typo fixes n°5 #5959

wants to merge 3 commits into from

Conversation

Amxx
Copy link
Collaborator

@Amxx Amxx commented Sep 29, 2025

No description provided.

@Amxx Amxx requested a review from a team as a code owner September 29, 2025 08:16
@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Sep 29, 2025 •
edited
Loading

⚠️ No Changeset found

Latest commit: 0571375

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Sep 29, 2025

Walkthrough

This change updates a documentation comment in contracts/mocks/docs/ERC4626Fees.sol. Specifically, the docstring for the _withdraw function now references IERC4626-_withdraw instead of IERC4626-_deposit. There are no code, logic, or interface modifications; only the comment text was corrected.

Possibly related PRs

Pre-merge checks and finishing touches

❌ Failed checks (2 inconclusive)
Check name Status Explanation Resolution
Title Check ❓ Inconclusive The title “Group typo fixes n°5” is overly generic and does not convey the specific documentation change made to the ERC4626Fees.sol file, making it unclear to reviewers what the pull request actually addresses. Please revise the title to clearly summarize the main change, for example “docs: correct IERC4626-_withdraw reference in ERC4626Fees.sol comment” so that reviewers immediately understand the purpose of the pull request.
Description Check ❓ Inconclusive No description was provided for this pull request, so it’s impossible to confirm the intent or context of the documented reference update, leaving reviewers without guidance on the significance of the change. Please add a brief description outlining that this pull request fixes a typo in the _withdraw function’s doc comment by referencing IERC4626-_withdraw rather than IERC4626-_deposit in ERC4626Fees.sol.
✅ Passed checks (1 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch typo-fixes

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

  • Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
  • Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Please see the documentation for more information.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

coderabbitai[bot]
coderabbitai bot reviewed Sep 29, 2025
View reviewed changes
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
contracts/mocks/docs/ERC4626Fees.sol (1)

48-49: Optional: point cross-refs to ERC4626 (not IERC4626) for underscored hooks.

_deposit/_withdraw are internal hooks on ERC4626, not part of IERC4626. Consider adjusting the doc links so they resolve to the actual symbols.

Proposed doc-only diff:

-    /// @dev Send entry fee to {_entryFeeRecipient}. See {IERC4626-_deposit}.
+    /// @dev Send entry fee to {_entryFeeRecipient}. See {ERC4626-_deposit}.
@@
-    /// @dev Send exit fee to {_exitFeeRecipient}. See {IERC4626-_withdraw}.
+    /// @dev Send exit fee to {_exitFeeRecipient}. See {ERC4626-_withdraw}.

Please confirm these anchors resolve in the generated docs.

Also applies to: 60-61

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5eb047a and a1aa81b.

📒 Files selected for processing (1)
  • contracts/mocks/docs/ERC4626Fees.sol (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (6)
  • GitHub Check: coverage
  • GitHub Check: slither
  • GitHub Check: tests-foundry
  • GitHub Check: tests-upgradeable
  • GitHub Check: tests
  • GitHub Check: halmos
🔇 Additional comments (1)
contracts/mocks/docs/ERC4626Fees.sol (1)

60-61: Typo fix is correct.

Updating the comment to reference _withdraw (not _deposit) is accurate for this function.

arr00
arr00 previously approved these changes Sep 29, 2025
View reviewed changes
@Amxx Amxx marked this pull request as draft October 6, 2025 08:11
@mdfaizanaquil @Amxx
Update CHANGELOG.md (#5969)
0571375 
Co-authored-by: Hadrien Croubois <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@arr00 arr00 arr00 left review comments

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
ignore-changeset meta typo
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@Amxx @arr00 @strmfos @mdfaizanaquil